[docs] update other params type of metadata image routes #84491
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ijjk
added
created-by: Next.js team
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
docs/01-app/03-api-reference/03-file-conventions/01-metadata/opengraph-image.mdx
Show resolved
Hide resolved
icyJoseph
reviewed
Oct 7, 2025
docs/01-app/03-api-reference/03-file-conventions/01-metadata/opengraph-image.mdx
Outdated
Show resolved
Hide resolved
icyJoseph
reviewed
Oct 8, 2025
| | `app/shop/[tag]/[item]/opengraph-image.js` | `/shop/1/2` | `{ tag: '1', item: '2' }` | | ||
| | Route | URL | `params` | | ||
| | ------------------------------------------ | ----------- | ---------------------------------- | | ||
| | `app/shop/opengraph-image.js` | `/shop` | `Promise<undefined>` | |
There was a problem hiding this comment.
@huozhi I guess this one is technically correct though? or will the entire params object be undefined?
There was a problem hiding this comment.
oh yea this shouldn't change
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| | Route | URL | `params` | | ||
| | ------------------------------- | ----------- | ---------------------------------- | | ||
| | `app/shop/icon.js` | `/shop` | `Promise<undefined>` | | ||
| | `app/shop/[slug]/icon.js` | `/shop/1` | `Promise<{ slug: '1' >}` | |
There was a problem hiding this comment.
There's a syntax error in the Promise type declaration. The closing bracket is misplaced - it should be Promise<{ slug: '1' }> rather than Promise<{ slug: '1' >}.
Suggested change
| | `app/shop/[slug]/icon.js` | `/shop/1` | `Promise<{ slug: '1' >}` | | |
| | `app/shop/[slug]/icon.js` | `/shop/1` | `Promise<{ slug: '1' }>` | |
Spotted by Graphite Agent
Is this helpful? React 👍 or 👎 to let us know.
This comment came from an experimental review—please leave feedback if it was helpful/unhelpful. Learn more about experimental comments here.
docs/01-app/03-api-reference/04-functions/generate-image-metadata.mdx
Outdated
Show resolved
Hide resolved
docs/01-app/03-api-reference/03-file-conventions/01-metadata/app-icons.mdx
Outdated
Show resolved
Hide resolved
icyJoseph
approved these changes
Oct 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In v6, the
paramsargument of metadata image routes will become params, which is aligned with other page routes in App Router.The 2nd argument
idwill becomePromise<string>if you usegenerateImageMetadata